package com.leigq.www.mybatisplusstudy.domain.entity.base;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.FieldNameConstants;
import lombok.experimental.SuperBuilder;

import java.io.Serializable;

/**
 * 实体基类，每个实体都要有的属性
 *
 * @author leiguoqing
 */
@Data
@FieldNameConstants(level = AccessLevel.PROTECTED)
@AllArgsConstructor
@NoArgsConstructor
@SuperBuilder
public abstract class BaseEntity implements Serializable {

    /**
     * The constant serialVersionUID.
     */
    private static final long serialVersionUID = -6539444742613033263L;

    /**
     * 主键
     */
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Long id;


    /**
     * 获取表字段名称，一定要带表名称前缀，例如 department.name, 给自定义MP SQL使用
     *
     * @param fieldName 实体类中的属性名称，如果数据库和实体里面的名字不一样，则直接传数据库的字段名
     * @return the column name
     */
    protected static String getColumnName(String fieldName) {
        if ("deleted".equals(fieldName)) {
            // 特殊处理，数据库中的字段名是 is_deleted，实体里面是 deleted
            fieldName = "is_" + fieldName;
        }
        return StringUtils.camelToUnderline(fieldName);
    }
}
